Skip to content

docs(vm): correct overcommit defaults and warn about aggressive CPU ratio#1077

Open
abonillabeeche wants to merge 11 commits into
harvester:mainfrom
abonillabeeche:docs-resource-overcommit-and-vm-index
Open

docs(vm): correct overcommit defaults and warn about aggressive CPU ratio#1077
abonillabeeche wants to merge 11 commits into
harvester:mainfrom
abonillabeeche:docs-resource-overcommit-and-vm-index

Conversation

@abonillabeeche

Copy link
Copy Markdown
Contributor

Summary

Two related documentation fixes on the VM Management pages.

1. Resource Overcommit — defaults are wrong

The Resource Overcommit page still shows the pre-v1.8 defaults. The current values in `pkg/settings/settings.go#L46` are:

```
{"cpu":1000,"memory":150,"storage":100}
```

The doc is updated accordingly:

  • CPU allocation ratio: 1600% → 1000%
  • Storage allocation ratio: 200% → 100%

The change from `1600 → 1000` and `200 → 100` landed for v1.8.0 (verified against tags `v1.7.2` vs `v1.8.0`).

2. Encourage benchmarking vCPUs

A note is added to the Resource Overcommit page explaining that the default CPU allocation ratio of 1000% is still aggressive — under load it can produce noticeable CPU steal and latency spikes in guests. The note recommends benchmarking with a representative workload for latency-sensitive or sustained CPU-bound workloads and suggests a conservative starting point of 200–400%.

3. Point users at Resource Overcommit before creating VMs

A short note is added on the Virtual Machines landing page so users are steered to the Resource Overcommit page before creating VMs.

Both `docs/` and `versioned_docs/version-v1.8/` are updated.

Test plan

  • `npm run start` renders both pages without errors
  • The new admonition blocks render as the standard Docusaurus `:::note` style
  • Cross-page link from `virtual-machines.md` → `resource-overcommit.md` resolves in both `docs/` and `versioned_docs/version-v1.8/`

…tenments

Update the Volumes tab guidance to recommend the SCSI bus (virtio-scsi)
for Windows workloads that do sustained writes; virtio-scsi supports
multiple queues and has a more efficient DISCARD path than virtio-blk.

Clarify that the Cloud Config field is processed on Windows images that
include Cloudbase-Init (rather than being ignored outright).

Note that after VMDP is installed the network model can be switched
from e1000 to virtio for better throughput.

Add a new "Recommended Tuning" section documenting KubeVirt's Hyper-V
TLFS enlightenments as a suggested performance tuning for Windows
guests, with the full YAML block and a verification command.

Signed-off-by: Alejandro Bonilla <[email protected]>
…atio

Updates the Resource Overcommit page to reflect the current defaults
shipped in Harvester v1.8+:

  - CPU allocation ratio: 1600% -> 1000%
  - Storage allocation ratio: 200% -> 100%

Adds a note that the default CPU allocation ratio of 1000% is
aggressive and can produce noticeable CPU steal and latency spikes in
guests. Encourages benchmarking vCPUs for latency-sensitive or
sustained CPU-bound workloads and suggests a conservative starting
point of 200-400%.

Also adds a note on the Virtual Machines landing page pointing users
at the Resource Overcommit page before creating VMs so that the
allocation ratios can be reviewed against workload requirements.

Signed-off-by: Alejandro Bonilla <[email protected]>

@jillian-maroket jillian-maroket left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review done

Comment thread docs/vm/virtual-machines.md Outdated
Comment thread docs/vm/resource-overcommit.md Outdated
Comment thread docs/vm/create-windows-vm.md Outdated
Comment thread docs/vm/create-windows-vm.md Outdated
Comment thread docs/vm/create-windows-vm.md Outdated
Comment thread docs/vm/create-windows-vm.md Outdated
Comment thread docs/vm/create-windows-vm.md Outdated
Comment thread docs/vm/create-windows-vm.md Outdated
Comment thread docs/vm/create-windows-vm.md Outdated
abonillabeeche and others added 9 commits July 13, 2026 10:41
Co-authored-by: Jillian Maroket <[email protected]>
Signed-off-by: Alejandro Bonilla <[email protected]>
Co-authored-by: Jillian Maroket <[email protected]>
Signed-off-by: Alejandro Bonilla <[email protected]>
Co-authored-by: Jillian Maroket <[email protected]>
Signed-off-by: Alejandro Bonilla <[email protected]>
Co-authored-by: Jillian Maroket <[email protected]>
Signed-off-by: Alejandro Bonilla <[email protected]>
Co-authored-by: Jillian Maroket <[email protected]>
Signed-off-by: Alejandro Bonilla <[email protected]>
Co-authored-by: Jillian Maroket <[email protected]>
Signed-off-by: Alejandro Bonilla <[email protected]>
Co-authored-by: Jillian Maroket <[email protected]>
Signed-off-by: Alejandro Bonilla <[email protected]>
Co-authored-by: Jillian Maroket <[email protected]>
Signed-off-by: Alejandro Bonilla <[email protected]>
Co-authored-by: Jillian Maroket <[email protected]>
Signed-off-by: Alejandro Bonilla <[email protected]>

@jillian-maroket jillian-maroket left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks!

@mergify

mergify Bot commented Jul 14, 2026

Copy link
Copy Markdown

Tick the box to add this pull request to the merge queue (same as @mergifyio queue).

  • Queue this pull request

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants